Motion.SetGroupPositionOffset method

Sets the position of all axes in a group without moving the axes. The new coordinates are described in an array. With the coordinate system input a coordinate system is selected accordingly. The input coordinates will be converted from the provided coordinate system to the specified coordinate system for the values to be sent to individual axes. The position will be updated for all available coordinate systems.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus SetGroupPositionOffset(
       int Index,
       double[] Position,
       bool Relative,
       McCoordSystem CoordSystem,
       McExecutionMode ExecutionMode
)

Public Function SetGroupPositionOffset(
       Index As Integer,
       Position As Double(),
       Relative As Boolean,
       CoordSystem As McCoordSystem,
       ExecutionMode As McExecutionMode
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

Position [in]

Type: double[]

The array of coordinates that represents the desired position of the group, including positions and orientations. Each axis in the group needs one value. It means distance if Relative = true.

Relative [in]

Type: bool

The mode of position inputs. true: Relative distance. false: Absolute position. By default it's false.

CoordSystem [in]

Type: McCoordSystem

A coordinate system.

ExecutionMode [in]

Type: McExecutionMode

Defines the chronological sequence of a method.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Examples

N/A